干货 | Api 体系架构分享（下）

上一篇，讲到了，最近，在做 api 的设计

对于设计，一方面是对于后端 server 框架的设计，另一方面呢，是对于整个 api 体系的设计

在这里呢，我们来理理思路，先来大致分一下块

风格就不用说了，我们就用 restful 风格，接下来：

• IDL，也就是我们所说的接口描述语言

• server 框架，整个 api 服务的核心驱动

• 版本控制

• 还有一些辅助工具，比如说，自动化工具、认证授权、监控上报、日志记录、检索等等

---

上次呢，讲了 IDL 和 server 框架的设计思路

这次呢，来吧剩下两个也给说说

版本控制

说到版本控制，大多数人的大脑中都一定会立刻想到 git 和 svn 吧，只可惜，这次的主角可不是他们

虽说 git 和 svn 虽好，对于一些项目也能够进行很好的开发，但是呢，对于某些场景，还是有些 hold 不住的

比如，我们来举一个场景：

现在我们的源码大约有 500M，然后呢，采用的是分支开发，主干发布，但是呢，因为我们是提供中间层 service 的，迭代周期很短，对于一些特殊的客户，会时常有些特殊的逻辑处理，每个开发者可能会有好几个分支进行开发，这个样子的话，对于这些特殊逻辑，特殊版本的管理就非常的不方便，而且，因为每次都要拉出来一个分支，然后改动可能非常小，这就造成了非常大量的冗余量

于是，这个场景中，冗余量、大量迭代版本的管理，就上升到了我们的一个主要问题

如何解决呢？

单体代码库

在这里，我们引入一个节点（标签）的概念，先来说一下整体思路

现在，我们就抛弃 git 和 svn 的思想，把所有的代码都放在一起，通过控制 节点粒度 来控制整体的冗余

首先，节点粒度我们先设定为以文件为单位，同时呢，约定我们的命名规范，文件名.节点标识.php，例如 Test.v1.php

接下来呢，就会有我们原始的版本，在这个原始的版本里面，所有的文件都是 base 节点

所有的文件都会有一个父节点，最终都是继承与 base 节点的

当我们需要迭代到 1.0.1 版本的时候，我们只要把需要改动的文件 copy 一个副本，然后按规范命名，接着只需对于这一个文件进行改动，这样，冗余的粒度就控制在了这个文件内

大大减少冗余的同时，还大大的提高了代码的复用，避免了菱形依赖，不同团队间的跨团队协作也变得更加灵活

接下来，我们怎么能够正常调用呢？

所以说，这种单体代码库需要一个路由引擎来驱动，这就要我们根据实际情况来实现了，可以直接根据节点表示来路由，也可以在中间加一层路由映射表，这就看具体需求了

同理，我们可以进一步调整节点粒度，来控制整体的冗余，比如，粒度细化到接口级别

~~~~~~ 萌萌哒的分割线 ~~~~~~~~~

好了，下面就来分析一下这种单体代码库的优劣

优点：

• 统一版本控制

• 广泛地代码共享和复用

• 简化依赖管理，避免菱形依赖

• 原子修改

• 大规模重构

• 跨团队协作

• 灵活的团队边界和代码所有权

• 代码可见性以及清晰的树形结构提供了隐含的团队命名空间

但是呢，随着代码量的增加，也会出现以下问题：

• 单体模型让代码结构更容易理解，但却让代码发现变得更困难

• 开发人员需要能够查看代码库，找到相关程序库，并看看如何使用它们以及谁编写了它们。这就需要有代码搜索和代码浏览工具

• 依赖重构和代码清理辅助工具，定期对无用代码进行清理

• 版本管理的重心转移到了冗余控制上

所以说呢，对于管理，我们就需要开发一套额外的自动化工具了

具体关于单体代码库的细节也可以查看这篇文章：

---

ok，关于版本控制就说这么多，接下来就是最后的一些自动化工具以及辅助工程了

自动化工具

为什么需要自动化工具呢？

一方面，节约我们维护开发的成本，对于一些可以自动化的操作就没必要去人工操作

另一方面呢，也是为了减少人工操作中可能带来的一些失误

就比如我们现在的 api，都需要哪些自动化工具呢？

• SDK 自动生成工具：对于我们提供给用户的 SDK，我们当然不希望每次迭代都要重新给用户写一份新的，所以说呢，通过自动化工具，自动生成各种语言调用的 SDK 是很有必要的

• IDL 解析工具：我们在读取数据的时候，肯定不能每次都去解析 IDL 的结构，这样会带来太多不必要的额外开销，所以说呢，我们需要提前解析 IDL 进行缓存，从而提高我们调用的速度，而这个解析生成的过程，就交给工具来完成了

• 代码库搜索工具：因为我们采用了单体代码库，所以慢慢的代码越来越多，代码搜索工具就变的必不可少了

• 代码发现工具：也是为了维护代码库，定期发现清理无用代码

至于一些其他的自动化工具，就根据大家的具体需求去实现吧，也就不一一列举了

其他辅助工具

比如说，认证、授权、监控、上报、日志等等

这些在 server 框架设计的同时就都要考虑进去，什么时候需要上报，如何设定日志格式从而使得我们能够更加方便的去维护等等

对于日志管理，可以使用一些开源系统快速搭建

比如，logstash 来搭建日志管理系统，通过 ElasticSearch 来进行索引检索服务，然后呢使用 kibana 作为分析和可视化平台

---

ok，api 设计分享就到这里

FROM: 一只热爱动漫的攻城狮 ~ ~ ~